home *** CD-ROM | disk | FTP | other *** search
/ Mac-Source 1994 July / Mac-Source_July_1994.iso / C and C++ / Utilities / Winter Shell 1.0d2 / Source / PopupCDEF 1.0b2 / PopupLib.c < prev    next >
Encoding:
Text File  |  1994-01-19  |  42.8 KB  |  1,435 lines  |  [TEXT/KAHL]
  1. /*
  2.     Distribution
  3.     ------------
  4.     
  5.     You can use this code and the compiled popup CDEF in any freely
  6.     distributed product (as in the GNU General Public License), just
  7.     give credit somewhere appropriate (like the documentation). For
  8.     commercial distribution please contact the author. Please keep the
  9.     files together if you redistribute them.
  10.     
  11.     I would also be interested in any improvements made to
  12.     this software.
  13.     
  14.     (c) Copyright 1994, Ari Halberstadt
  15.     
  16.     Ari Halberstadt
  17.     9 Whittemore Rd.
  18.     Newton, MA 02158-2105
  19.     USA
  20.     
  21.     ari@world.std.com
  22.     
  23.     Description
  24.     -----------
  25.     
  26.     Functions implementing a popup menu. To create a popup call
  27.     PopupBegin and then PopupCurrentSet to set the initial item.
  28.     Use PopupCurrent to find out which item was selected. There
  29.     are quite a few other functions for controling how the popup
  30.     is displayed: whether the popup is drawn, whether the popup
  31.     is visible, enabling and disabling the popup, whether to
  32.     use the window font to display the popup, setting the text
  33.     style for the title, and more. The defaults are set by
  34.     PopupBegin to be those recommended by Apple in IM-VI. This
  35.     library is the basis for a popup menu 'CDEF'.
  36.     
  37.     You can use the popup CDEF to create a popup menu. The control's
  38.     contrlData field will contain a handle to the popup. If you need to
  39.     directly modify the popup, you can call the popup library routines
  40.     on the handle. However, first call PopupVersion and make sure it
  41.     is equal to kPopupVersion. If it isn't, then don't use the popup
  42.     library to modify the control. In practice, it is better to use
  43.     Control Manager routines to modify the popup.
  44.     
  45.     If you implement keyboard equivalents of menu commands, then you can
  46.     use PopupHilite to hilite the title of the menu while executing the
  47.     menu command.
  48.     
  49.     Significant care has been taken to ensure that the popup menus
  50.     will always appear nicely. For instance, when the menu is created,
  51.     it will not exceed the size of the bounding rectangle specified
  52.     for it, and the width of the popup menu will not exceed the width
  53.     of the actual menu.
  54.     
  55.     To Do
  56.     -----
  57.     
  58.     Color support needs to be added. Without a color Macintosh there's
  59.     no way for me to test color code, so this popup just uses the
  60.     original QuickDraw. For color support, the current selection should
  61.     be drawn in the same color as the menu item; when the menu definition
  62.     function is called to draw the item the color will be set correctly,
  63.     but PopupDrawSelectionString should also set the colors. The CopyBits
  64.     code must be adapted to use CopyPixMap. Finally, The PopupHilite
  65.     routine should set HiliteMode so that color hiliting is done
  66.     correctly.
  67.     
  68.     A minor allignment problem may occur when the text style of the
  69.     popup's title results in a line height different from the line
  70.     height of the plain system font (or, if the wfont attribute is
  71.     true, then different from the height of the window's font).
  72.     For instance, if the title's style is outline+underline+bold,
  73.     its height may differ by several pixels from the height
  74.     currently calculated.
  75.     
  76.     Revision History
  77.     ----------------
  78.     
  79.     93/12/28 aih
  80.     - Continued cleaning up code, added some more comments.
  81.     - Uses menu definition function to draw the current selection. This
  82.     eliminated a couple of rectangles from the popup structure and
  83.     means that the current selection will always be drawn correctly,
  84.     even if it includes icons and command keys. A special one item menu
  85.     is used to hold a copy of the currently selected menu item. This special
  86.     menu is then used to calculate the height of the item and to draw the
  87.     item.
  88.     
  89.     93/12/26 aih
  90.     - Major overhaul. Rewrote rectangle calculation code, since it wasn't
  91.     working right. It's still not as simple as I'd like, but it's better
  92.     than before. Also added attributes to make more compatible with Apple's
  93.     popup CDEF (such as using the window font to display the menu).
  94.     
  95.     93/12/24 aih
  96.     - Converted to use handles.
  97.     - Removed dependence on all other libraries, so that this library
  98.     is completely self contained; the few external functions that were
  99.     necessary (e.g., strcpy, pstrfit) were copied or coded directly into
  100.     this file. This will make this library more suitable for use as a
  101.     CDEF since the linker won't pull in a lot of extra code from other
  102.     libraries.
  103.     
  104.     93/12/23 aih
  105.     - updated for current version of libraries
  106.     - added port parameter to PopupBegin
  107.     
  108.     91/11/11 aih
  109.     - Removed useless "PopupObj..." stuff
  110.     
  111.     91/03/01-05 aih
  112.     - Update events are handled
  113.     - Added comment describing this file
  114.     - The popup's title is allocated as a handle in the heap
  115.     - The popup is allocated as a handle in the heap
  116.     - Attribute values are only updated if nescessary
  117.     - The function PopupDraw first draws the popup to an offscreen bitmap
  118.     and then copies it to the popup's port. This eliminates flicker when
  119.     the popup is used as a CDEF, since the Control Manager sends a draw
  120.     message to a control whenever the control is clicked, even if no
  121.     drawing is actually needed.
  122.     
  123.     91/01/05 aih
  124.     - Inserted this standard header in all files
  125.  
  126.     90/12/15 Ari Halberstadt (aih)
  127.     - Created this file */
  128.  
  129. #include <Script.h>
  130. #include "PopupLib.h"
  131.  
  132. /*---------------------------------------------------------------------------*/
  133. /* constants */
  134. /*---------------------------------------------------------------------------*/
  135.  
  136. /* To support drawing of icons and other special menu items in the
  137.     current selection box, we create a special private menu containing
  138.     as its sole item a copy of the currently selected menu item. We
  139.     then call the menu definition function to draw the menu. If this
  140.     feature is disabled, only the text of the current menu item is
  141.     drawn. */
  142. #define DONT_USE_MDEF                (0)
  143.     
  144. #ifndef NDEBUG
  145.  
  146.     /* Define this as 1 to enable framing of the various rectangles of the menu.
  147.         This is useful when debugging since it clearly displays the rectangles,
  148.         which are tricky to calculate. */
  149.     #define DRAW_RECTANGLES            (0)
  150.  
  151.     /* To reduce flicker the popup is normally first drawn to an off-screen
  152.         bitmap, then copied to the screen. To make debugging easier disable
  153.         offscreen drawing. Then you can step through each draw routine to
  154.         ensure that it is drawing correctly. */
  155.     #define DONT_DRAW_OFFSCREEN    (0)
  156.     
  157.     /* Another useful debugging trick is to define the following as something
  158.         greater than 1. This helps spot and fix off-by-one errors caused by
  159.         not taking into account of the size of the frame and drop shadow. 
  160.         A value of at least 1/4" (18 pixels) provides good visual feedback
  161.         and allows measuring areas with a ruler. */
  162.     #define kFrameSize                (1)    /* width of frame around popup */
  163.     #define kShadowSize                (1)    /* width of shadow around popup */
  164.     
  165. #else /* NDEBUG */
  166.  
  167.     #define DRAW_RECTANGLES            (0)    /* if 1, draws frames around areas */
  168.     #define DONT_DRAW_OFFSCREEN    (0)    /* if 1, doesn't use offscreen bitmap */
  169.     #define kFrameSize                (1)    /* width of frame around popup */
  170.     #define kShadowSize                (1)    /* size of shadow around popup */
  171.     
  172. #endif /* NDEBUG */
  173.  
  174. #define kEllipses                        '…'    /* character appended to long strings */
  175. #define kPopupMenuID                    (1)    /* id of popup's private menu */
  176. #define kShadowOffset                (3)    /* amount to offset shadow from frame */
  177. #define kArrowWidth                    (11)    /* width of the down arrow */
  178. #define kArrowHeight                    (6)    /* height of the down arrow */
  179. #define kArrowMargin                    (5)    /* margin around arrow */
  180. #define kTitleMargin                    (5)    /* margin around title */
  181. #define kTitleMarginBottom            (1)    /* margin below title */
  182.  
  183. /*---------------------------------------------------------------------------*/
  184. /* low-memory globals */
  185. /*---------------------------------------------------------------------------*/
  186.  
  187. #define TopMenuItem    (0xA0A)
  188. #define AtMenuBottom    (0xA0C)
  189.  
  190. static void SetTopMenuItem(short top)
  191. {
  192.     *(short *) TopMenuItem = top;
  193. }
  194.  
  195. static void SetAtMenuBottom(short bottom)
  196. {
  197.     *(short *) AtMenuBottom = bottom;
  198. }
  199.  
  200. /*---------------------------------------------------------------------------*/
  201. /* utilities, copied from various libraries to reduce code overhead in CDEF */
  202. /*---------------------------------------------------------------------------*/
  203.  
  204. #if CDEF
  205.     #define HandleValidSize(h, n)    (true)
  206.     #define MenuValid(m)                (true)
  207.     #define require(x)                ((void) 0)
  208.     #define ensure(x)                    ((void) 0)
  209.     #define check(x)                    ((void) 0)
  210. #else /* CDEF */
  211.     #include "MemoryLib.h"
  212.     #include "MenuLib.h"
  213.     #include "RectangleLib.h"
  214. #endif /* CDEF */
  215.  
  216. /* return minimum of two numbers */
  217. static long min(long a, long b)
  218. {
  219.     return(a < b ? a : b);
  220. }
  221.  
  222. /* return maximum of two numbers */
  223. static long max(long a, long b)
  224. {
  225.     return(a > b ? a : b);
  226. }
  227.  
  228. /* fit string to width by truncating it and adding the extra character,
  229.     return width of string */
  230. static short pstrfit(Str255 str, short maxwidth, char extra)
  231. {
  232.     short extrawidth;
  233.     short width;
  234.  
  235.     require(maxwidth >= 0);
  236.     width = StringWidth(str);
  237.     if (width > maxwidth) {
  238.         if (maxwidth == 0) {
  239.             /* optimization */
  240.             width = 0;
  241.             *str = 0;
  242.         }
  243.         else {
  244.             /* truncate one character (or multi-byte character)
  245.                 at a time */
  246.             while (*str > 0) {
  247.                 str[*str] = extra;
  248.                 width = StringWidth(str);
  249.                 if (width <= maxwidth)
  250.                     break;
  251.                 while (CharByte((Ptr) str, *str) > 0) {
  252.                     check(*str > 1);
  253.                     --*str;
  254.                 }
  255.                 check(*str > 0);
  256.                 --*str;
  257.             }
  258.         }
  259.     }
  260.     ensure(width <= maxwidth);
  261.     ensure(width == StringWidth(str));
  262.     return(width);
  263. }
  264.  
  265. /* get the text attributes */
  266. static void GetTextState(TextState *text)
  267. {
  268.     GrafPtr port;
  269.     
  270.     GetPort(&port);
  271.     text->font = port->txFont;
  272.     text->face = port->txFace;
  273.     text->mode = port->txMode;
  274.     text->size = port->txSize;
  275. }
  276.  
  277. /* set the text attributes */
  278. static void SetTextState(const TextState *text)
  279. {
  280.     TextFont(text->font);
  281.     TextFace(text->face);
  282.     TextMode(text->mode);
  283.     TextSize(text->size);
  284. }
  285.  
  286. /* Flip the rectangle 'flip' horizontally (mirror image) relative to
  287.     the rectangle 'within'. */    
  288. static void RectFlip(Rect *flip, const Rect *within)
  289. {
  290.     short offset;
  291.     
  292.     require(RectValid(flip));
  293.     require(RectValid(within));
  294.     require(within->left <= flip->left && flip->right <= within->right);
  295.     offset = (within->right - flip->right) - (flip->left - within->left);
  296.     flip->left += offset;
  297.     flip->right += offset;
  298. }
  299.  
  300. /* paint over the rectangle with the gray pattern */
  301. static void RectDisable(const Rect *r)
  302. {
  303.     PenState pen;
  304.     Pattern pat;
  305.  
  306.     require(RectValid(r));
  307.     GetIndPattern(pat, sysPatListID, 4);
  308.     GetPenState(&pen);
  309.     PenPat(pat);
  310.     PenMode(patBic);
  311.     PaintRect(r);
  312.     SetPenState(&pen);
  313. }
  314.  
  315. /* true if the menu item is enabled */
  316. static Boolean MenuItemEnabled(MenuHandle menu, short item)
  317. {
  318.     require(MenuValid(menu));
  319.     require(0 <= item && item <= CountMItems(menu));
  320.     return(item > 31 || ((**menu).enableFlags & (1 << item)) != 0);
  321. }
  322.  
  323. /*---------------------------------------------------------------------------*/
  324. /* routines for executing a menu definition procedure */
  325. /*---------------------------------------------------------------------------*/
  326.  
  327. typedef pascal void (*MenuProcPtr)(short msg, MenuHandle menu, Rect *bounds,
  328.     Point hit, short *which);
  329.  
  330. static void mdef(short msg, MenuHandle menu, Rect *bounds,
  331.     Point hit, short *which)
  332. {
  333.     Handle mdef = (**menu).menuProc;
  334.     SignedByte state = HGetState(mdef);
  335.     HLock(mdef);
  336.     ((MenuProcPtr) *mdef)(msg, menu, bounds, hit, which);
  337.     HSetState(mdef, state);
  338. }
  339.  
  340. static void mdef_draw(MenuHandle menu, const Rect *bounds)
  341. {
  342.     Point hit = { 0, 0 };
  343.     short which = 0;
  344.     Rect tmp = *bounds;
  345.     
  346.     mdef(mDrawMsg, menu, &tmp, hit, &which);
  347. }
  348.  
  349. /*---------------------------------------------------------------------------*/
  350. /* popup menu routines */
  351. /*---------------------------------------------------------------------------*/
  352.  
  353. /* true if the popup is valid */
  354. Boolean PopupValid(PopupHandle popup)
  355. {
  356.     if (! HandleValidSize(popup, sizeof(PopupType))) return(false);
  357.     if (! MenuValid((**popup).menu)) return(false);
  358.     if ((**popup).version != kPopupVersion) return(false);
  359.     return(true);
  360. }
  361.  
  362. /*---------------------------------------------------------------------------*/
  363. /* port setup and restore */
  364. /*---------------------------------------------------------------------------*/
  365.  
  366. /* Remember the current drawing environment and set the drawing environment 
  367.     to that needed by the popup menu. Must be balanced with a call
  368.     to PopupPortRestore. */
  369. static void PopupPortSetup(PopupHandle popup)
  370. {
  371.     GrafPtr port;
  372.     PenState pen;
  373.     TextState text;
  374.     
  375.     require(! (**popup).state.envset);    
  376.     
  377.     /* save current settings */
  378.     GetPort(&port);
  379.     GetPenState(&pen);
  380.     GetTextState(&text);
  381.     (**popup).state.oldenv.port = port;
  382.     (**popup).state.oldenv.pen = pen;
  383.     (**popup).state.oldenv.text = text;
  384.     
  385.     /* save clip region and clip to max bounds */
  386.     if ((**popup).state.oldenv.clip) {
  387.         Rect maxbounds = (**popup).r.maxbounds;
  388.         GetClip((**popup).state.oldenv.clip);
  389.         ClipRect(&maxbounds);
  390.     }
  391.         
  392.     /* get window manager port's settings */
  393.     GetWMgrPort(&port);
  394.     SetPort(port);
  395.     GetPenState(&pen);
  396.     GetTextState(&text);
  397.     
  398.     /* apply settings */
  399.     SetPort((**popup).port);
  400.     if (! (**popup).attr.wfont) {
  401.         SetPenState(&pen);
  402.         SetTextState(&text);
  403.     }
  404.     
  405.     (**popup).state.envset = true;
  406.     ensure((**popup).state.envset);
  407. }
  408.  
  409. /* Restore the drawing environment to its original state. Must be
  410.     balanced with a call to PopupPortSetup. */
  411. static void PopupPortRestore(PopupHandle popup)
  412. {
  413.     GrafPtr port;
  414.     PenState pen;
  415.     TextState text;
  416.  
  417.     require((**popup).state.envset);    
  418.     port = (**popup).state.oldenv.port;
  419.     pen = (**popup).state.oldenv.pen;
  420.     text = (**popup).state.oldenv.text;
  421.     if ((**popup).state.oldenv.clip) {
  422.         SetClip((**popup).state.oldenv.clip);
  423.         SetEmptyRgn((**popup).state.oldenv.clip);
  424.     }
  425.     SetTextState(&text);
  426.     SetPenState(&pen);
  427.     SetPort(port);
  428.     (**popup).state.envset = false;    
  429.     ensure(! (**popup).state.envset);
  430. }
  431.  
  432. /*---------------------------------------------------------------------------*/
  433. /* rectangle calculation routines */
  434. /*---------------------------------------------------------------------------*/
  435.  
  436. /* copy the current item from the main menu to a private menu; we can
  437.     then use the private menu to determine the size of the menu item
  438.     and to draw the menu item */
  439. static void PopupAdjustMenu(PopupHandle popup)
  440. {
  441.     const StringPtr notempty = (StringPtr) "\p ";
  442.     MenuHandle menu;
  443.     Str255 item;
  444.     Style style;
  445.     short icon;
  446.     
  447.     if (! (**popup).state.selection) {
  448.         /* create the private menu */
  449.         check(*notempty);
  450.         menu = NewMenu(kPopupMenuID, notempty);
  451.         if (menu) {
  452.             (**popup).state.selection = menu;
  453.             AppendMenu(menu, notempty);
  454.         }
  455.     }
  456.     if ((**popup).state.selection) {
  457.         /* copy the current selection's attributes, except for the item's
  458.             mark and command key, which don't need to be displayed */
  459.         GetItem((**popup).menu, (**popup).state.current, item);
  460.         GetItemIcon((**popup).menu, (**popup).state.current, &icon);
  461.         GetItemStyle((**popup).menu, (**popup).state.current, &style);
  462.         if (*item) { /* zero length item string is not allowed in menus */
  463.             SetItem((**popup).state.selection, 1, item);
  464.             SetItemIcon((**popup).state.selection, 1, icon);
  465.             SetItemStyle((**popup).state.selection, 1, style);
  466.         }
  467.     }
  468.     ensure(! (**popup).state.selection ||
  469.                 CountMItems((**popup).state.selection) == 1);
  470. }
  471.  
  472. /* set popup's rectangles and erase old popup if the frame has changed */
  473. static PopupRectanglesSet(PopupHandle popup, const PopupRectanglesType *r)
  474. {
  475.     Rect bounds;
  476.     RgnHandle eraseRgn;
  477.     
  478.     bounds = (**popup).r.bounds;
  479.     if (! EqualRect(&bounds, &r->bounds)) {
  480.         eraseRgn = NewRgn();
  481.         if (eraseRgn && (**popup).utilRgn) {
  482.             /* to reduce flicker only erase the
  483.                 area that doesn't overlap */
  484.             check(EmptyRgn((**popup).utilRgn));
  485.             RectRgn(eraseRgn, &bounds);
  486.             RectRgn((**popup).utilRgn, &r->bounds);
  487.             DiffRgn(eraseRgn, (**popup).utilRgn, eraseRgn);
  488.             EraseRgn(eraseRgn);
  489.             DisposeRgn(eraseRgn);
  490.             SetEmptyRgn((**popup).utilRgn);
  491.         }
  492.         else
  493.             EraseRect(&bounds);
  494.     }
  495.     (**popup).r = *r;
  496. }
  497.  
  498. /* calculate the popup's rectangles */
  499. void PopupCalculate(PopupHandle popup)
  500. {
  501.     struct {                                /* margins around some items */
  502.         struct { short left, right; } selection;
  503.         struct { short left, right; } title;
  504.         struct { short left, right; } arrow;
  505.     } margin = {
  506.         { kFrameSize, 0 },            /* selection */
  507.         { kTitleMargin, kTitleMargin },    /* title */
  508.         { 0, kArrowMargin },            /* arrow */
  509.     };
  510.     struct {                                /* minimum widths of each item */
  511.         short content;
  512.         short hilite;
  513.         short title;
  514.         short arrow;
  515.         short selection;
  516.     } minwidth;
  517.     short lineHeight;                    /* height of a line */
  518.     short menuHeight;                    /* height of the selected menu item */
  519.     short menuWidth;                    /* width of the menu */
  520.     short maxwidth;                    /* for calculating maximum widths of items */
  521.     short width;                        /* for calculating widths of items */
  522.     FontInfo font;                        /* info about the current font size */
  523.     Str255 title;                        /* the popup's title */
  524.     Rect content;                        /* rectangle enclosing content (excludes frame) */
  525.     PopupRectanglesType r;            /* the calculated rectangles */
  526.     
  527.     /* don't calculate if drawing is turned off */
  528.     if (! (**popup).attr.draw) return;
  529.     
  530.     /* initialize settings */
  531.  
  532.     PopupPortSetup(popup);
  533.     PopupTitle(popup, title);
  534.  
  535.     /* get information about the current font */
  536.     GetFontInfo(&font);
  537.     lineHeight = font.ascent + font.descent + font.leading;
  538.     
  539.     /* get width of menu and down arrow */
  540.     CalcMenuSize((**popup).menu);
  541.     menuWidth = (**(**popup).menu).menuWidth + kArrowWidth + kArrowMargin;
  542.  
  543.     /* get height of current selection */
  544.     menuHeight = 0;
  545.     PopupAdjustMenu(popup);
  546.     if ((**popup).state.selection) {
  547.         CalcMenuSize((**popup).state.selection);
  548.         menuHeight = (**(**popup).state.selection).menuHeight;
  549.     }
  550.     if (menuHeight < lineHeight)
  551.         menuHeight = lineHeight;
  552.     if (menuHeight < kArrowHeight + 4)
  553.         menuHeight = kArrowHeight + 4;
  554.         
  555.     /* adjust margins */
  556.     
  557.     if (! *title || (**popup).attr.typein) {
  558.         /* Type-in popups don't display the title or the current selection,
  559.             so their margins aren't needed. If the title is empty then the
  560.             title's margins can also be empty. */
  561.         if ((**popup).attr.typein) {
  562.             margin.arrow.left = 2;
  563.             margin.arrow.right = 2;
  564.             menuHeight = lineHeight;
  565.             font.widMax = 0;
  566.         }
  567.         margin.title.left = 0;
  568.         margin.title.right = 0;
  569.     }
  570.     
  571.     /* for right justified popups we need a little extra space for the drop
  572.         shadow between the current selection area and the title */
  573.     if ((**popup).attr.just == teJustRight)
  574.         margin.selection.left += kShadowSize;
  575.         
  576.     /* calculate minimum widths */
  577.     
  578.     minwidth.arrow = kArrowWidth;
  579.     minwidth.title = (*title ? font.widMax : 0);
  580.     minwidth.hilite = minwidth.title + margin.title.left + margin.title.right;
  581.     minwidth.selection = font.widMax + minwidth.arrow + margin.arrow.left + margin.arrow.right;
  582.     minwidth.content = minwidth.hilite + minwidth.selection +
  583.                             margin.selection.left + margin.selection.right;
  584.     
  585.     /* calculate rectangles */
  586.     
  587.     r.maxbounds = (**popup).r.maxbounds;
  588.     
  589.     /* calculate content rectangle; all the other rectangles will be
  590.         caculated relative to this rectangle */
  591.     content.top = r.maxbounds.top + kFrameSize;
  592.     content.left = r.maxbounds.left + kFrameSize;
  593.     content.bottom = content.top + menuHeight;
  594.     content.right = content.left +
  595.         max(r.maxbounds.right - r.maxbounds.left - 2 * kFrameSize - kShadowSize,
  596.              minwidth.content);
  597.  
  598.     /* vertically center content in maxbounds */
  599.     {    short offset = ((r.maxbounds.bottom - r.maxbounds.top) -
  600.                                (content.bottom - content.top)) / 2;
  601.         OffsetRect(&content, 0, max(0, offset - kShadowSize));
  602.     }
  603.     
  604.     /* calculate hilite rectangle */
  605.     r.hilite = content;
  606.     r.hilite.left = content.left;
  607.     r.hilite.right = content.right - minwidth.selection;
  608.  
  609.     /* calculate title rectangle */
  610.     check(content.bottom - content.top >= lineHeight);
  611.     r.title.top = content.top + (content.bottom - content.top - lineHeight) / 2;
  612.     r.title.left = content.left + margin.title.left;
  613.     r.title.bottom = r.title.top + lineHeight - kTitleMarginBottom;
  614.     if ((**popup).attr.typein || ! *title)
  615.         width = 0; /* don't show title */
  616.     else {
  617.         maxwidth =
  618.             r.hilite.right - r.hilite.left -
  619.             margin.title.left - margin.title.right;
  620.         check(maxwidth >= minwidth.title);
  621.         if ((**popup).attr.title.width) {
  622.             /* use fixed title width as specified by application */
  623.             width = min(maxwidth, (**popup).attr.title.width);
  624.             width = max(width, minwidth.title);
  625.         }
  626.         else {
  627.             /* use actual width of title string */
  628.             Style style = (**popup).port->txFace;
  629.             TextFace((**popup).attr.title.style);
  630.             width = pstrfit(title, maxwidth, kEllipses);
  631.             TextFace(style);
  632.         }
  633.         check(width <= maxwidth);
  634.     }
  635.     check(width >= minwidth.title);
  636.     r.title.right = r.title.left + width;
  637.  
  638.     /* adjust right edge of hilite rectangle now that width of title is known */
  639.     r.hilite.right = r.title.right + margin.title.right;
  640.     
  641.     /* calculate selection rectangle, initially using the maximum possible width */
  642.     r.selection = content;
  643.     r.selection.left = r.hilite.right + margin.selection.left;
  644.     r.selection.right = content.right - margin.selection.right;
  645.  
  646.     /* calculate width of current selection */
  647.     if ((**popup).attr.typein)
  648.         width = minwidth.selection;
  649.     else {
  650.         maxwidth = r.selection.right - r.selection.left;
  651.         check(maxwidth >= minwidth.selection);
  652.         width = min(maxwidth, menuWidth);
  653.         width = max(width, minwidth.selection);
  654.     }
  655.  
  656.     /* adjust right edge now that we know how wide everything is */
  657.     r.selection.right = r.selection.left + width;
  658.     content.right = r.selection.right + margin.selection.right;
  659.     
  660.     /* calculate arrow rectangle--center arrow vertically at right edge of
  661.         selection rectangle */
  662.     check(content.bottom - content.top >= kArrowHeight);
  663.     r.arrow.top = content.top + (content.bottom - content.top - kArrowHeight) / 2;
  664.     r.arrow.left = r.selection.right - kArrowWidth - margin.arrow.right;
  665.     r.arrow.bottom = r.arrow.top + kArrowHeight;
  666.     r.arrow.right = r.arrow.left + kArrowWidth;
  667.  
  668.     /* calculate frame rectangle--surrounds content area, and includes the
  669.         frame and shadow */
  670.     r.bounds.top = content.top - kFrameSize;
  671.     r.bounds.left = content.left - kFrameSize;
  672.     r.bounds.right = content.right + kFrameSize;
  673.     r.bounds.bottom = content.bottom + kFrameSize + kShadowSize;
  674.     if ((**popup).attr.just != teJustRight)
  675.         r.bounds.right += kShadowSize; /* in teJustRight shadow is part of content */
  676.     
  677.     /* mirror image rectangles if using a right justified menu */
  678.     if ((**popup).attr.just == teJustRight) {
  679.         Rect maxbounds;
  680.         
  681.         /* copy and adjust maxbounds so flipping will work */
  682.         maxbounds.top = r.maxbounds.top;
  683.         maxbounds.left = r.maxbounds.left;
  684.         maxbounds.bottom = r.maxbounds.top +
  685.             max(r.maxbounds.bottom - r.maxbounds.top,
  686.                  r.bounds.bottom - r.bounds.top);
  687.         maxbounds.right = r.maxbounds.left +
  688.             max(r.maxbounds.right - r.maxbounds.left,
  689.                  r.bounds.right - r.bounds.left);
  690.  
  691.         /* flip the rectangles */
  692.         RectFlip(&r.bounds, &maxbounds);
  693.         RectFlip(&r.hilite, &maxbounds);
  694.         RectFlip(&r.selection, &maxbounds);
  695.         RectFlip(&r.title, &maxbounds);
  696.         RectFlip(&r.arrow, &maxbounds);
  697.     }
  698.     
  699.     check(RectWidth(&r.hilite) >= minwidth.hilite);
  700.     check(RectWidth(&r.title) >= minwidth.title);
  701.     check(RectWidth(&r.selection) >= minwidth.selection);
  702.     check(RectWidth(&r.arrow) >= minwidth.arrow);
  703.     check(RectWithin(&r.hilite, &r.bounds));
  704.     check(RectWithin(&r.title, &r.hilite));
  705.     check(RectWithin(&r.selection, &r.bounds));
  706.     check(RectWithin(&r.arrow, &r.selection));
  707.     check(! RectWithin(&r.hilite, &r.selection));
  708.     check(! RectWithin(&r.selection, &r.hilite));
  709.  
  710.     PopupRectanglesSet(popup, &r);
  711.     PopupPortRestore(popup);
  712. }
  713.  
  714. /*---------------------------------------------------------------------------*/
  715. /* more drawing routines */
  716. /*---------------------------------------------------------------------------*/
  717.  
  718. /* draw the frame around the popup menu */
  719. static void PopupDrawFrame(PopupHandle popup)
  720. {
  721.     Rect frame;
  722.     PenState pen;
  723.     
  724.     require((**popup).state.envset);
  725.     
  726.     /* save state */
  727.     GetPenState(&pen);
  728.     
  729.     /* draw frame */
  730.     frame = (**popup).r.bounds;    
  731.     if ((**popup).attr.just == teJustRight)
  732.         frame.right = (**popup).r.selection.right + kFrameSize + kShadowSize;
  733.     else
  734.         frame.left = (**popup).r.selection.left - kFrameSize;
  735.     frame.right -= kShadowSize;
  736.     frame.bottom -= kShadowSize;
  737.     PenSize(kFrameSize, kFrameSize);
  738.     FrameRect(&frame);
  739.  
  740.     /* draw drop shadow */
  741.     PenSize(kShadowSize, kShadowSize);
  742.     MoveTo(frame.right, frame.top + kShadowOffset);
  743.     LineTo(frame.right, frame.bottom);
  744.     LineTo(frame.left + kShadowOffset, frame.bottom);
  745.     
  746.     /* restore state */
  747.     SetPenState(&pen);
  748. }
  749.  
  750. /* draw the down arrow */
  751. static void PopupDrawArrow(PopupHandle popup)
  752. {
  753.     Rect arrow;        /* arrow's rectangle */
  754.     short    height;    /* height of arrow */
  755.     short    width;    /* width of current line */
  756.     short    i;            /* index to lines of arrow */
  757.     
  758.     require((**popup).state.envset);
  759.     arrow = (**popup).r.arrow;
  760.     height = kArrowHeight;
  761.     width = kArrowWidth - 1;
  762.     for (i = 0; i < height; i++) {
  763.         MoveTo(arrow.left + i, arrow.top + i);
  764.         LineTo(arrow.left + i + width, arrow.top + i);
  765.         width -= 2;
  766.     }
  767. }
  768.  
  769. /* draw string within bounds; if too long truncate and append ellipses */
  770. static void PopupDrawString(PopupHandle popup, Str255 str, const Rect *bounds)
  771. {
  772.     FontInfo    font;
  773.     short width;
  774.     
  775.     require((**popup).state.envset);
  776.     require(RectValid(bounds));
  777.     GetFontInfo(&font);
  778.     width = pstrfit(str, bounds->right - bounds->left, kEllipses);
  779.     if ((**popup).attr.just == teJustRight)
  780.         MoveTo(bounds->right - width, bounds->bottom - font.descent);
  781.     else
  782.         MoveTo(bounds->left, bounds->bottom - font.descent);
  783.     DrawString(str);
  784. }
  785.  
  786. /* draw the current selection string within the specified rectangle
  787.     by calling the menu definition function */
  788. static void PopupDrawSelectionMDEF(PopupHandle popup, const Rect *bounds)
  789. {
  790.     require((**popup).state.envset);
  791.     require(RectValid(bounds));
  792.     SetTopMenuItem(bounds->top);
  793.     SetAtMenuBottom(bounds->bottom);
  794.     mdef_draw((**popup).state.selection, bounds);    
  795. }
  796.  
  797. /* draw the current selection string within the specified rectangle
  798.     without calling the menu definition function */
  799. static void PopupDrawSelectionString(PopupHandle popup, const Rect *bounds)
  800. {
  801.     Str255 item;        /* current selection string */
  802.     FontInfo font;        /* information about the current font */
  803.     Style itemStyle;    /* menu item's style */
  804.     Style portStyle;    /* port's style */
  805.     Rect selection;    /* rectangle to draw string in */
  806.     
  807.     require((**popup).state.envset);
  808.     
  809.     /* allign the string with the title string and with the string
  810.         in the menu item */
  811.     GetFontInfo(&font);
  812.     selection.left = bounds->left;
  813.     selection.right = bounds->right;
  814.     selection.top = (**popup).r.title.top;
  815.     selection.bottom = (**popup).r.title.bottom;
  816.     if ((**popup).attr.just == teJustRight)
  817.         selection.right -= font.widMax;
  818.     else
  819.         selection.left += font.widMax;
  820.     
  821.     /* use the text style of the menu item and draw item */
  822.     GetItem((**popup).menu, (**popup).state.current, item);
  823.     GetItemStyle((**popup).menu, (**popup).state.current, &itemStyle);
  824.     portStyle = (**popup).port->txFace;
  825.     TextFace(itemStyle);
  826.     PopupDrawString(popup, item, &selection);
  827.     TextFace(portStyle);
  828.     
  829.     /* gray over selection if item is disabled */
  830.     if (! MenuItemEnabled((**popup).menu, (**popup).state.current))
  831.         RectDisable(&selection);
  832. }
  833.  
  834. /* draw the current selection by calling the menu definition function */
  835. static void PopupDrawSelection(PopupHandle popup)
  836. {
  837.     Rect selection;                /* current selection rectangle */
  838.     Boolean usemdef = false;    /* if true, selection is drawn using MDEF */
  839.  
  840.     require((**popup).state.envset);
  841.     require(! (**popup).attr.typein);
  842.     
  843.     /* exclude arrow from selection rectangle */
  844.     selection = (**popup).r.selection;
  845.     if ((**popup).attr.just == teJustRight)
  846.         selection.left += kArrowWidth + kArrowMargin;
  847.     else
  848.         selection.right -= kArrowWidth + kArrowMargin;
  849.     check(RectValid(&selection));
  850.     
  851.     if ((**popup).state.selection) {
  852.         /* The menu definition function doesn't respect the right edge of the
  853.             bounding rectangle. If the menu is wider than the bounding rectangle,
  854.             it is simply drawn over whatever happens to be beyond the rectangle's
  855.             right edge. Since this wouldn't look very nice, we only use the
  856.             menu definition function if the menu would fit in the current
  857.             selection rectangle. Merely setting the clip region to the selection
  858.             rectangle isn't sufficient, since long strings should be truncated
  859.             with an ellipses character. */
  860.         CalcMenuSize((**popup).state.selection);
  861.         if ((**(**popup).state.selection).menuWidth <=
  862.               selection.right - selection.left)
  863.         {
  864.             #if ! DONT_USE_MDEF
  865.                 usemdef = true;
  866.             #endif /* DONT_USE_MDEF */
  867.         }
  868.     }
  869.     
  870.     /* draw current selection */
  871.     if (usemdef)
  872.         PopupDrawSelectionMDEF(popup, &selection);
  873.     else
  874.         PopupDrawSelectionString(popup, &selection);
  875. }
  876.  
  877. /* draw the title */
  878. static void PopupDrawTitle(PopupHandle popup)
  879. {
  880.     Style style;
  881.     Str255 title;
  882.     Rect rtitle;
  883.     
  884.     require((**popup).state.envset);
  885.     require(! (**popup).attr.typein);
  886.     rtitle = (**popup).r.title;
  887.     style = (**popup).port->txFace;
  888.     TextFace((**popup).attr.title.style);
  889.     PopupTitle(popup, title);
  890.     PopupDrawString(popup, title, &rtitle);
  891.     TextFace(style);
  892. }
  893.  
  894. /* gray out menu if it's disabled */
  895. static void PopupDrawEnable(PopupHandle popup)
  896. {
  897.     require(PopupValid(popup));
  898.     require((**popup).state.envset);
  899.     if (! (**popup).attr.enabled) {
  900.         Rect bounds = (**popup).r.bounds;
  901.         RectDisable(&bounds);
  902.     }
  903. }
  904.  
  905. /* erase the popup menu */
  906. static void PopupErase(PopupHandle popup)
  907. {
  908.     Rect bounds;
  909.     
  910.     require((**popup).state.envset);
  911.     bounds = (**popup).r.bounds;
  912.     EraseRect(&bounds);
  913. }
  914.  
  915. #ifdef DRAW_RECTANGLES
  916. /* draw frames around the parts of the popup */
  917. static void PopupDrawRectangles(PopupHandle popup)
  918. {
  919.     Rect shadow;
  920.     PenState pen;
  921.     Rect frame, r;
  922.  
  923.     GetIndPattern(black, sysPatListID, 1);
  924.     GetIndPattern(dkGray, sysPatListID, 2);
  925.     GetIndPattern(gray, sysPatListID, 4);
  926.     GetIndPattern(white, sysPatListID, 20);
  927.  
  928.     GetPenState(&pen);
  929.     
  930.     /* draw grayed outline of frame and shadow */
  931.     if (kFrameSize > 2 || kShadowSize > 2) {
  932.         /* calculate frame */
  933.         frame = (**popup).r.bounds;    
  934.         if ((**popup).attr.just == teJustRight)
  935.             frame.right = (**popup).r.selection.right + kFrameSize + kShadowSize;
  936.         else
  937.             frame.left = (**popup).r.selection.left - kFrameSize;
  938.         frame.right -= kShadowSize;
  939.         frame.bottom -= kShadowSize;
  940.         
  941.         /* draw outline of frame */
  942.         PenPat(gray);
  943.         FrameRect(&frame);
  944.         InsetRect(&frame, kFrameSize, kFrameSize);
  945.         FrameRect(&frame);
  946.         InsetRect(&frame, -kFrameSize, -kFrameSize);
  947.         
  948.         /* draw outline of shadow */
  949.         shadow.top = frame.bottom;
  950.         shadow.left = frame.left + kShadowOffset;
  951.         shadow.bottom = shadow.top + kShadowSize;
  952.         shadow.right = frame.right + kShadowSize;
  953.         FrameRect(&shadow);
  954.         shadow.top = frame.top + kShadowOffset;
  955.         shadow.left = frame.right;
  956.         shadow.bottom = frame.bottom + kShadowSize;
  957.         shadow.right = shadow.left + kShadowSize;
  958.         FrameRect(&shadow);
  959.         PenNormal();
  960.     }
  961.  
  962.     /* draw the other rectangles */
  963.     r = (**popup).r.maxbounds; FrameRect(&r);
  964.     r = (**popup).r.title; FrameRect(&r);
  965.     r = (**popup).r.hilite; FrameRect(&r);
  966.     r = (**popup).r.selection; FrameRect(&r);
  967.     r = (**popup).r.arrow; FrameRect(&r);
  968.     SetPenState(&pen);
  969. }
  970. #endif /* DRAW_RECTANGLES */
  971.  
  972. /* draw the menu */
  973. static void PopupDrawDirect(PopupHandle popup)
  974. {
  975.     require(PopupValid(popup));
  976.     PopupErase(popup);
  977.     if ((**popup).attr.visible) {
  978.     
  979.         /* draw all the parts of the popup */
  980.         if (! (**popup).attr.typein) {
  981.             PopupDrawSelection(popup);
  982.             PopupDrawTitle(popup);
  983.         }
  984.         PopupDrawFrame(popup);
  985.         PopupDrawArrow(popup);
  986.         PopupDrawEnable(popup);
  987.         
  988.         #if DRAW_RECTANGLES
  989.             PopupDrawRectangles(popup);
  990.         #endif /* DRAW_RECTANGLES */
  991.     }
  992. }
  993.  
  994. /* draw the popup to an offscreen bitmap, then copy the bitmap to the screen */
  995. void PopupDraw(PopupHandle popup)
  996. {
  997.     BitMap    svbits;            /* port's saved bitmap */
  998.     BitMap    offbits;            /* off screen bitmap */
  999.     Boolean    reallocated;    /* if true, bitmap needs to be redrawn */
  1000.     long        baseAddrSize;    /* size of base address for bitmap */
  1001.     
  1002.     require(PopupValid(popup));
  1003.     if ( ! (**popup).attr.draw) return;
  1004.     
  1005.     /* setup drawing environment */
  1006.     PopupPortSetup(popup);
  1007.         
  1008.     /* setup offscreen bitmap */
  1009.     if ((**popup).baseAddr) {
  1010.         
  1011.         /* calculate bitmap dimensions */
  1012.         offbits.bounds = (**popup).r.bounds;
  1013.         offbits.rowBytes = ((((offbits.bounds.right - offbits.bounds.left) + 15) / 16) * 2);
  1014.         baseAddrSize = (long) offbits.rowBytes * (offbits.bounds.bottom - offbits.bounds.top);
  1015.  
  1016.         /* reallocate bitmap for drawing offscreen */
  1017.         reallocated = false;
  1018.         if (GetHandleSize((**popup).baseAddr) != baseAddrSize) {
  1019.             ReallocateHandle((**popup).baseAddr, baseAddrSize);
  1020.             reallocated = true;
  1021.         }
  1022.     }
  1023.     
  1024.     /* draw from the offscreen bitmap */
  1025.     if ((**popup).baseAddr && *(**popup).baseAddr && ! MemError()) {
  1026.         
  1027.         /* lock and dereference base address */
  1028.         MoveHHi((**popup).baseAddr);
  1029.         HLock((**popup).baseAddr);
  1030.         offbits.baseAddr = *(**popup).baseAddr;
  1031.     
  1032.         if (reallocated) {
  1033.             /* substitute offscreen bitmap for port's bitmap and draw the popup */
  1034.             GrafPtr port;
  1035.             GetPort(&port);
  1036.             SetPort((**popup).port);
  1037.             svbits = (**popup).port->portBits;
  1038.             SetPortBits(&offbits);
  1039.             PopupDrawDirect(popup);
  1040.             SetPortBits(&svbits);
  1041.             SetPort(port);
  1042.         }
  1043.  
  1044.         /* calculate mask region */
  1045.         if ((**popup).utilRgn) {
  1046.             check(EmptyRgn((**popup).utilRgn));
  1047.             CopyRgn((**popup).port->clipRgn, (**popup).utilRgn);
  1048.             SectRgn((**popup).port->visRgn, (**popup).utilRgn, (**popup).utilRgn);
  1049.         }
  1050.         
  1051.         /* copy the popup from the offscreen bitmap to the popup's port */
  1052.         CopyBits(&offbits, &(**popup).port->portBits,
  1053.             &offbits.bounds, &offbits.bounds, srcCopy, (**popup).utilRgn);
  1054.         
  1055.         if ((**popup).utilRgn)
  1056.             SetEmptyRgn((**popup).utilRgn);
  1057.         HUnlock((**popup).baseAddr);
  1058.     }
  1059.     else {
  1060.         /* couldn't allocate offscreen bitmap, but the popup can still be drawn */
  1061.         PopupDrawDirect(popup);
  1062.     }
  1063.  
  1064.     /* restore drawing environment */
  1065.     PopupPortRestore(popup);
  1066. }
  1067.  
  1068. /* hilite the popup's title; useful for keyboard equivalents of commands */
  1069. void PopupHilite(PopupHandle popup)
  1070. {
  1071.     GrafPtr port;
  1072.     Rect hilite;
  1073.     
  1074.     GetPort(&port);
  1075.     SetPort((**popup).port);
  1076.     hilite = (**popup).r.hilite;
  1077.     InvertRect(&hilite);
  1078.     SetPort(port);
  1079. }
  1080.  
  1081. /*---------------------------------------------------------------------------*/
  1082. /* event handling */
  1083. /*---------------------------------------------------------------------------*/
  1084.  
  1085. /* True if point (in local coordinates) is within the popup menu.
  1086.     Call this before calling PopupMouseDown. */
  1087. Boolean PopupWithin(PopupHandle popup, Point pt)
  1088. {
  1089.     Boolean result = false;
  1090.     
  1091.     require(PopupValid(popup));
  1092.     if ((**popup).attr.visible && (**popup).attr.enabled) {
  1093.         Rect selection = (**popup).r.selection;
  1094.         result = PtInRect(pt, &selection);
  1095.     }
  1096.     return(result);
  1097. }
  1098.  
  1099. /* call this when there's a mouse down in a popup menu */
  1100. void PopupSelect(PopupHandle popup)
  1101. {
  1102.     long    chosen;                /* item selected from menu */
  1103.     Point    location;            /* top left of menu */
  1104.     Boolean inserted;            /* true if inserted menu into menu list */
  1105.     TextState txStatePopup;    /* popup port's text state */
  1106.     TextState txStateWMgr;    /* window manager port's text state */
  1107.     GrafPtr wmgrPort;            /* window manager's port */
  1108.     
  1109.     require(PopupValid(popup));
  1110.     if (StillDown()) {
  1111.     
  1112.         /* setup port */
  1113.         PopupPortSetup(popup);
  1114.         
  1115.         /* insert menu into heirarchical menu list if necessary */
  1116.         inserted = false;
  1117.         if (! GetMHandle((**(**popup).menu).menuID)) {
  1118.             InsertMenu((**popup).menu, -1);
  1119.             inserted = true;
  1120.         }
  1121.         
  1122.         /* hilite title */
  1123.         PopupHilite(popup);
  1124.         
  1125.         /* calculate position for popup menu */
  1126.         location.h = (**popup).r.selection.left;
  1127.         location.v = (**popup).r.selection.top;
  1128.         LocalToGlobal(&location);
  1129.         
  1130.         if ((**popup).attr.wfont) {
  1131.             /* PopUpMenuSelect always draws the popup in the window manager
  1132.                 port, so if we want to draw in the window's font we have
  1133.                 to apply its settings to the window manager port */
  1134.             GetTextState(&txStatePopup);
  1135.             GetWMgrPort(&wmgrPort);
  1136.             SetPort(wmgrPort);
  1137.             GetTextState(&txStateWMgr);
  1138.             SetTextState(&txStatePopup);
  1139.         }
  1140.         
  1141.         /* make the menu wide enough to include the down arrow */
  1142.         if (! (**popup).attr.typein) {
  1143.             CalcMenuSize((**popup).menu);
  1144.             (**(**popup).menu).menuWidth += kArrowWidth + kArrowMargin;
  1145.         }
  1146.         
  1147.         /* let user select an item from the menu */
  1148.         chosen = PopUpMenuSelect((**popup).menu, location.v, location.h,
  1149.                                          (**popup).state.current);
  1150.         
  1151.         /* restore menu width */
  1152.         if (! (**popup).attr.typein)
  1153.             CalcMenuSize((**popup).menu);
  1154.  
  1155.         /* restore environment */
  1156.         if ((**popup).attr.wfont) {
  1157.             SetTextState(&txStateWMgr);
  1158.             SetPort((**popup).port);
  1159.             CalcMenuSize((**popup).menu);
  1160.         }
  1161.         PopupHilite(popup);
  1162.         if (inserted)
  1163.             DeleteMenu((**(**popup).menu).menuID);
  1164.         PopupPortRestore(popup);
  1165.         
  1166.         /* display the selected item */
  1167.         if (LoWord(chosen))
  1168.             PopupCurrentSet(popup, LoWord(chosen));
  1169.     }
  1170.     ensure(PopupValid(popup));
  1171. }
  1172.     
  1173. /*---------------------------------------------------------------------------*/
  1174. /* getting and setting attributes */
  1175. /*---------------------------------------------------------------------------*/
  1176.  
  1177. /* recalculate and redraw the popup */
  1178. static void PopupChanged(PopupHandle popup)
  1179. {
  1180.     /* purge bitmap to force rebuilding it */
  1181.     if ((**popup).baseAddr)
  1182.         EmptyHandle((**popup).baseAddr);
  1183.  
  1184.     /* recalculate and redraw everything */
  1185.     PopupCalculate(popup);
  1186.     PopupDraw(popup);
  1187. }
  1188.  
  1189. /* return the version of the library that created the popup menu */
  1190. short PopupVersion(PopupHandle popup)
  1191. {
  1192.     return((**popup).version);
  1193. }
  1194.  
  1195. /* return the currently selected menu item */
  1196. short PopupCurrent(PopupHandle popup)
  1197. {
  1198.     require(PopupValid(popup));
  1199.     return((**popup).state.current);
  1200. }
  1201.  
  1202. /* set the currently selected menu item */
  1203. void PopupCurrentSet(PopupHandle popup, short current)
  1204. {
  1205.     require(PopupValid(popup));
  1206.     if (current != (**popup).state.current) {
  1207.         SetItemMark((**popup).menu, (**popup).state.current, noMark);
  1208.         SetItemMark((**popup).menu, current, (**popup).attr.mark);
  1209.         (**popup).state.current = current;
  1210.         PopupChanged(popup);
  1211.     }
  1212. }
  1213.  
  1214. /* turn drawing on or off */
  1215. void PopupDrawSet(PopupHandle popup, Boolean draw)
  1216. {
  1217.     require(PopupValid(popup));
  1218.     (**popup).attr.draw = draw;
  1219. }
  1220.  
  1221. /* make popup visible or invisible */
  1222. void PopupVisibleSet(PopupHandle popup, Boolean visible)
  1223. {    
  1224.     require(PopupValid(popup));    
  1225.     if (visible != (**popup).attr.visible) {
  1226.         (**popup).attr.visible = visible;
  1227.         PopupChanged(popup);
  1228.     }    
  1229. }
  1230.  
  1231. /* set the character used to mark the current menu item */
  1232. void PopupMarkSet(PopupHandle popup, char mark)
  1233. {
  1234.     require(PopupValid(popup));
  1235.     if (mark != (**popup).attr.mark) {
  1236.         (**popup).attr.mark = mark;
  1237.         SetItemMark((**popup).menu, (**popup).state.current, (**popup).attr.mark);
  1238.     }    
  1239. }
  1240.  
  1241. /* enable or disable the menu */
  1242. void PopupEnableSet(PopupHandle popup, Boolean enabled)
  1243. {
  1244.     require(PopupValid(popup));
  1245.     if (enabled != (**popup).attr.enabled) {
  1246.         (**popup).attr.enabled = enabled;
  1247.         PopupChanged(popup);
  1248.     }
  1249. }
  1250.  
  1251. /* turn type-in style menu on or off (IM-VI, p2-37) */
  1252. void PopupTypeInSet(PopupHandle popup, Boolean typein)
  1253. {
  1254.     require(PopupValid(popup));
  1255.     if (typein != (**popup).attr.typein) {
  1256.         (**popup).attr.typein = typein;
  1257.         PopupChanged(popup);
  1258.     }
  1259. }
  1260.  
  1261. /* return rectangle enclosing all of popup */
  1262. void PopupBounds(PopupHandle popup, Rect *bounds)
  1263. {
  1264.     require(PopupValid(popup));
  1265.     *bounds = (**popup).r.bounds;
  1266.     ensure(RectValid(bounds));
  1267. }
  1268.  
  1269. /* set popup's maximum bounding rectangle */
  1270. void PopupBoundsSet(PopupHandle popup, const Rect *maxbounds)
  1271. {
  1272.     Rect oldmax;
  1273.     
  1274.     require(PopupValid(popup));
  1275.     require(RectValid(maxbounds));
  1276.     oldmax = (**popup).r.maxbounds;
  1277.     if (! EqualRect(&oldmax, maxbounds)) {
  1278.         if ((**popup).attr.draw) {
  1279.             PopupPortSetup(popup);
  1280.             PopupErase(popup);
  1281.             PopupPortRestore(popup);
  1282.         }
  1283.         (**popup).r.maxbounds = *maxbounds;
  1284.         PopupChanged(popup);
  1285.     }
  1286. }
  1287.  
  1288. /* return popup's title */
  1289. void PopupTitle(PopupHandle popup, Str255 title)
  1290. {
  1291.     *title = 0;
  1292.     if ((**popup).attr.title.str) {
  1293.         BlockMove(*(**popup).attr.title.str, title,
  1294.             **(**popup).attr.title.str + 1);
  1295.     }
  1296. }
  1297.  
  1298. /* set popup's title  */
  1299. void PopupTitleSet(PopupHandle popup, const Str255 title)
  1300. {
  1301.     Str255 oldtitle;
  1302.     
  1303.     require(PopupValid(popup));
  1304.     if ((**popup).attr.title.str) {
  1305.         PopupTitle(popup, oldtitle);
  1306.         if (! EqualString(title, oldtitle, true, true)) {
  1307.             PtrToXHand(title, (**popup).attr.title.str, *title + 1);
  1308.             PopupChanged(popup);
  1309.         }
  1310.     }
  1311. }
  1312.  
  1313. /* set width of popup's title; the title is resized dynamically
  1314.     if the width is zero */
  1315. void PopupTitleWidthSet(PopupHandle popup, short width)
  1316. {
  1317.     require(width >= 0);
  1318.     if (width != (**popup).attr.title.width) {
  1319.         (**popup).attr.title.width = width;
  1320.         PopupChanged(popup);
  1321.     }
  1322. }
  1323.  
  1324. /* set the text style in which the popup's title will be drawn */
  1325. void PopupTitleStyleSet(PopupHandle popup, Style style)
  1326. {
  1327.     if (style != (**popup).attr.title.style) {
  1328.         (**popup).attr.title.style = style;
  1329.         PopupChanged(popup);
  1330.     }
  1331. }
  1332.  
  1333. /* set whether the popup will use the window's font for drawing the
  1334.     title, current selection, and menu */    
  1335. void PopupUseWFontSet(PopupHandle popup, Boolean wfont)
  1336. {
  1337.     if (wfont != (**popup).attr.wfont) {
  1338.         (**popup).attr.wfont = wfont;
  1339.         PopupChanged(popup);
  1340.     }
  1341. }
  1342.  
  1343. /* set the justification style for drawing the popup */
  1344. void PopupJustSet(PopupHandle popup, short just)
  1345. {
  1346.     if (just != (**popup).attr.just) {
  1347.         (**popup).attr.just = just;
  1348.         PopupChanged(popup);
  1349.     }
  1350. }
  1351.  
  1352. /*---------------------------------------------------------------------------*/
  1353. /* allocation and disposal */
  1354. /*---------------------------------------------------------------------------*/
  1355.  
  1356. /*    Create a popup menu within the rectangle in the specified port.
  1357.     Drawing is initially off. Since the popup's title is initially
  1358.     empty, you should call PopupTitleSet if you want the popup to
  1359.     have a title. When you're finished configuring the popup call
  1360.     PopupDrawSet to enable drawing and then call PopupCalculate.
  1361.     The popup's rectangles are only calculated when drawing
  1362.     is enabled. The popup menu allocates several utility handles,
  1363.     but will function, albeit not as well, even if it can't allocate
  1364.     any of the utility handles. The popup menu is drawn to an offscreen
  1365.     bitmap and then copied to the screen; the storage for the bitmap
  1366.     is kept in a relocatable and purgeable block. */
  1367. PopupHandle PopupBegin(GrafPtr port, MenuHandle menu, const Rect *maxbounds)
  1368. {
  1369.     PopupHandle popup;
  1370.     void *tmp;
  1371.     
  1372.     require(MenuValid(menu));
  1373.     require(RectValid(maxbounds));
  1374.     
  1375.     /* allocate popup */
  1376.     popup = (PopupHandle) NewHandleClear(sizeof(PopupType));
  1377.     if (popup) {
  1378.     
  1379.         /* initialize internal state */
  1380.         (**popup).version = kPopupVersion;
  1381.         (**popup).port = port;
  1382.         (**popup).menu = menu;
  1383.         (**popup).private.mHandle = menu;
  1384.         (**popup).private.mID = (**menu).menuID;
  1385.         (**popup).r.maxbounds = *maxbounds;
  1386.         
  1387.         /* initialize flags affecting display and operation of menu */
  1388.         (**popup).attr.visible = true;
  1389.         (**popup).attr.enabled = true;
  1390.         (**popup).attr.mark = checkMark;
  1391.         (**popup).attr.just = GetSysJust();
  1392.         
  1393.         /* allocate title */
  1394.         tmp = NewHandleClear(1);
  1395.         (**popup).attr.title.str = tmp;
  1396.  
  1397.         /* allocate utility region */
  1398.         tmp = NewRgn();
  1399.         (**popup).utilRgn = tmp;
  1400.  
  1401.         /* allocate region for saving and restoring the clip region */
  1402.         tmp = NewRgn();
  1403.         (**popup).state.oldenv.clip = tmp;
  1404.         
  1405.         /* allocate bitmap's base address; the handle is purgeable since
  1406.             we can always rebuild the data it contains and since we can
  1407.             always draw the popup directly to the screen, though it may
  1408.             flicker a bit */
  1409.         #if ! DONT_DRAW_OFFSCREEN
  1410.             tmp = NewHandle(0);
  1411.             (**popup).baseAddr = tmp;
  1412.             if ((**popup).baseAddr)
  1413.                 HPurge((**popup).baseAddr);
  1414.         #endif /* DONT_DRAW_OFFSCREEN */
  1415.     }
  1416.     ensure(! popup || PopupValid(popup));
  1417.     return(popup);
  1418. }
  1419.  
  1420. /* end use of the popup menu */
  1421. void PopupEnd(PopupHandle popup)
  1422. {
  1423.     require(! popup || PopupValid(popup));
  1424.     if (popup) {
  1425.         if ((**popup).state.oldenv.clip) DisposeRgn((**popup).state.oldenv.clip);
  1426.         if ((**popup).state.selection) DisposeMenu((**popup).state.selection);
  1427.         if ((**popup).attr.title.str) DisposeHandle((**popup).attr.title.str);
  1428.         if ((**popup).baseAddr) DisposeHandle((**popup).baseAddr);
  1429.         if ((**popup).utilRgn) DisposeRgn((**popup).utilRgn);
  1430.         DisposeHandle((Handle) popup);
  1431.         popup = NULL;
  1432.     }
  1433.     ensure(! PopupValid(popup));
  1434. }
  1435.